﻿<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>

  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Class BodyOutputConfig
 </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Class BodyOutputConfig
 ">
  
    <link rel="shortcut icon" href="../../favicon.ico">
    <link rel="stylesheet" href="../../styles/docfx.vendor.css">
    <link rel="stylesheet" href="../../styles/docfx.css">
    <link rel="stylesheet" href="../../styles/main.css">
    <meta property="docfx:navrel" content="../../toc.html">
    <meta property="docfx:tocrel" content="toc.html">
  
  
  
  </head>
  <body data-spy="scroll" data-target="#affix" data-offset="120">
    <div id="wrapper">
      <header>

        <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
          <div class="container">
            <div class="navbar-header">
              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
              </button>

              <a class="navbar-brand" href="../../index.html">
                <img id="logo" class="svg" src="../../logo.svg" alt="">
              </a>
            </div>
            <div class="collapse navbar-collapse" id="navbar">
              <form class="navbar-form navbar-right" role="search" id="search">
                <div class="form-group">
                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
                </div>
              </form>
            </div>
          </div>
        </nav>

        <div class="subnav navbar navbar-default">
          <div class="container hide-when-search" id="breadcrumb">
            <ul class="breadcrumb">
              <li></li>
            </ul>
          </div>
        </div>
      </header>
      <div role="main" class="container body-content hide-when-search">

        <div class="sidenav hide-when-search">
          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
          <div class="sidetoggle collapse" id="sidetoggle">
            <div id="sidetoc"></div>
          </div>
        </div>
        <div class="article row grid-right">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.BodyOutputConfig">


  <h1 id="com_CIMthetics_CSharpSECSTools_TextFormatter_BodyOutputConfig" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.BodyOutputConfig" class="text-break">Class BodyOutputConfig
</h1>
  <div class="markdown level0 summary"><p>The properties of this class control the output format of
<code>SECSItem</code> objects or in other words the body or content of
a SECS message.</p>
</div>
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
    <h5>Inheritance</h5>
    <div class="level0"><span class="xref">System.Object</span></div>
    <div class="level1"><span class="xref">BodyOutputConfig</span></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="com.CIMthetics.CSharpSECSTools.TextFormatter.html">com.CIMthetics.CSharpSECSTools.TextFormatter</a></h6>
  <h6><strong>Assembly</strong>: TextFormatter.dll</h6>
  <h5 id="com_CIMthetics_CSharpSECSTools_TextFormatter_BodyOutputConfig_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class BodyOutputConfig</code></pre>
  </div>
  <h3 id="properties">Properties
</h3>


  <a id="com_CIMthetics_CSharpSECSTools_TextFormatter_BodyOutputConfig_DisplayAsElementsOrAttributes_" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.BodyOutputConfig.DisplayAsElementsOrAttributes*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_TextFormatter_BodyOutputConfig_DisplayAsElementsOrAttributes" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.BodyOutputConfig.DisplayAsElementsOrAttributes">DisplayAsElementsOrAttributes</h4>
  <div class="markdown level1 summary"><p>This property is pretty much only here to support &quot;automatic&quot; creation
from a <code>json</code> file.  It will ultimately set the <code>DisplayAsType</code>
property.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public string DisplayAsElementsOrAttributes { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td><p>The only permissible value is &quot;Elements&quot; or &quot;Attributes&quot;.</p>
</td>
      </tr>
    </tbody>
  </table>


  <a id="com_CIMthetics_CSharpSECSTools_TextFormatter_BodyOutputConfig_DisplayAsType_" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.BodyOutputConfig.DisplayAsType*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_TextFormatter_BodyOutputConfig_DisplayAsType" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.BodyOutputConfig.DisplayAsType">DisplayAsType</h4>
  <div class="markdown level1 summary"><p>This property controls how a <code>SECSItem</code> is displayed in the
case where a formatter is configured to output using XML.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public DisplayAsType DisplayAsType { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="com.CIMthetics.CSharpSECSTools.TextFormatter.DisplayAsType.html">DisplayAsType</a></td>
        <td><p>If this property's value is <code>DisplayAsType.Elements</code> a message's
body will be displayed using XML elements for the various <code>SECSItem</code>(s)
elements therein. If the value is <code>DisplayAsType.Attributes</code>
the body will be displayed using XML attributes for the various <code>SECSItem</code>(s)
elements therein.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 id="com_CIMthetics_CSharpSECSTools_TextFormatter_BodyOutputConfig_DisplayAsType_remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>This property's value has no effect if the output ends up being SML.</p>
<p>
The default is to display as Attributes.
</p>
</div>


  <a id="com_CIMthetics_CSharpSECSTools_TextFormatter_BodyOutputConfig_DisplayCount_" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.BodyOutputConfig.DisplayCount*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_TextFormatter_BodyOutputConfig_DisplayCount" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.BodyOutputConfig.DisplayCount">DisplayCount</h4>
  <div class="markdown level1 summary"><p>If the display format is SML this property controls whether or not &quot;count&quot;
values are displayed in the output.  These &quot;count&quot; values indicate how
many elements are in the individual <code>SECSItem</code>s.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool DisplayCount { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Boolean</span></td>
        <td><p>If <code>true</code> the value of the number of a <code>SECSItem</code>s elements is include in the output.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 id="com_CIMthetics_CSharpSECSTools_TextFormatter_BodyOutputConfig_DisplayCount_remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>This property only has an effect on output if the display format is SML.</p>
<p>
The default is <code>true</code>.
</p>
</div>


  <a id="com_CIMthetics_CSharpSECSTools_TextFormatter_BodyOutputConfig_DisplayLengthByteValue_" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.BodyOutputConfig.DisplayLengthByteValue*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_TextFormatter_BodyOutputConfig_DisplayLengthByteValue" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.BodyOutputConfig.DisplayLengthByteValue">DisplayLengthByteValue</h4>
  <div class="markdown level1 summary"><p>This property controls whether or not the value of the length bytes is
displayed in the output.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool DisplayLengthByteValue { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Boolean</span></td>
        <td><p>If <code>true</code> the value of the length bytes is include in the output.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 id="com_CIMthetics_CSharpSECSTools_TextFormatter_BodyOutputConfig_DisplayLengthByteValue_remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>The default is <code>false</code>.</p>
</div>


  <a id="com_CIMthetics_CSharpSECSTools_TextFormatter_BodyOutputConfig_DisplayNumberOfLengthBytes_" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.BodyOutputConfig.DisplayNumberOfLengthBytes*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_TextFormatter_BodyOutputConfig_DisplayNumberOfLengthBytes" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.BodyOutputConfig.DisplayNumberOfLengthBytes">DisplayNumberOfLengthBytes</h4>
  <div class="markdown level1 summary"><p>This property controls whether or not the number of length bytes is
displayed in the output.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool DisplayNumberOfLengthBytes { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Boolean</span></td>
        <td><p>If <code>true</code> the number of length bytes is include in the output.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 id="com_CIMthetics_CSharpSECSTools_TextFormatter_BodyOutputConfig_DisplayNumberOfLengthBytes_remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>The default is <code>false</code>.</p>
</div>


  <a id="com_CIMthetics_CSharpSECSTools_TextFormatter_BodyOutputConfig_MaxOutputLineLength_" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.BodyOutputConfig.MaxOutputLineLength*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_TextFormatter_BodyOutputConfig_MaxOutputLineLength" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.BodyOutputConfig.MaxOutputLineLength">MaxOutputLineLength</h4>
  <div class="markdown level1 summary"><p>This property controls the maximum length of line(s) produced for output.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public int MaxOutputLineLength { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Int32</span></td>
        <td><p>The maximum length in characters of output lines produced.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 id="com_CIMthetics_CSharpSECSTools_TextFormatter_BodyOutputConfig_MaxOutputLineLength_remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p><strong>Warning:</strong> If the length of this property is set too small an
infinite loop may be entered.  Setting the value of this property to
50 or larger should be okay.</p>
<p>
The default is <code>132</code> characters in length.
</p>
</div>
  <h3 id="methods">Methods
</h3>


  <a id="com_CIMthetics_CSharpSECSTools_TextFormatter_BodyOutputConfig_ToString_" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.BodyOutputConfig.ToString*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_TextFormatter_BodyOutputConfig_ToString" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.BodyOutputConfig.ToString">ToString()</h4>
  <div class="markdown level1 summary"><p>Creates a <code>string</code> displaying the current &quot;state&quot; of this instance.
This is mostly only useful for debugging.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
  </div>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h5 class="overrides">Overrides</h5>
  <div><span class="xref">System.Object.ToString()</span></div>
</article>
          </div>

          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <div class="contribution">
                <ul class="nav">
                </ul>
              </div>
              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
                <h5>In This Article</h5>
                <div></div>
              </nav>
            </div>
          </div>
        </div>
      </div>

      <footer>
        <div class="grad-bottom"></div>
        <div class="footer">
          <div class="container">
            <span class="pull-right">
              <a href="#top">Back to top</a>
            </span>
      
      <span>Generated by <strong>DocFX</strong></span>
          </div>
        </div>
      </footer>
    </div>

    <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
    <script type="text/javascript" src="../../styles/docfx.js"></script>
    <script type="text/javascript" src="../../styles/main.js"></script>
  </body>
</html>
